Finance APIs
Resource for creating new depreciation rules
| HTTP method | POST |
| URI | https://api.rambase.net/finance/depreciation-rules |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3563, version 1 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Name of depreciation rule
>{String}</Name>Description
Required/mandatory field
Description of depreciation rule
>{String}</Description>EffectivePeriod
Required/mandatory field
Effective period of the depreciation rule
Minimum value: 199000
Maximum value: 299912
>{Integer}</EffectivePeriod>Name
Required/mandatory field
Name of depreciation rule
": "{String}",Description
Required/mandatory field
Description of depreciation rule
": "{String}",EffectivePeriod
Required/mandatory field
Effective period of the depreciation rule
Minimum value: 199000
Maximum value: 299912
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
DepreciationRuleId
Depreciation rule identifier
>{Integer}</DepreciationRuleId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of depreciation rule
>{String}</Name>Description
Description of depreciation rule
>{String}</Description>DepreciationPeriods
Count of periods of depreciation rule
>{Integer}</DepreciationPeriods>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Amount
Amount limit of depreciation rule
>{Integer}</Amount>EffectivePeriod
Effective period of the depreciation rule
>{Integer}</EffectivePeriod>ExpirationPeriod
Expiration period of the depreciation rule
>{Integer}</ExpirationPeriod>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>DepreciationRuleId
Depreciation rule identifier
": "{Integer}",Status
Status of depreciation rule
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of depreciation rule
": "{String}",Description
Description of depreciation rule
": "{String}",Type
Type of depreciation rule
Possible domain values can be found here
": "{String}",DepreciationPeriods
Count of periods of depreciation rule
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",Amount
Amount limit of depreciation rule
": "{Integer}"EffectivePeriod
Effective period of the depreciation rule
": "{Integer}",ExpirationPeriod
Expiration period of the depreciation rule
": "{Integer}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",AccountNumber
The account number of the general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",AccountNumber
The account number of the general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101015 HTTP 404 | Permission not found |
| Error 100184 HTTP 404 | Accounting period not found |
| Error 100608 HTTP 400 | Not a valid year in the period {0} |
| Error 100609 HTTP 400 | Illegal month in period {0} |
| Error 100613 HTTP 400 | Expiration period must be later than effective period |
| Error 105645 HTTP 400 | Update of balance account, depreciation account or periods are not allowed in this status |